using System;
using System.Collections;
using System.Collections.Specialized;
using System.Data;
using System.Data.SqlTypes;
using System.Data.SqlClient;
using System.Text;
using ECommerce.DAL;


namespace Entity
{
    /// <summary>
    /// This object represents the Private Fields of TblStateTax.
    /// </summary>

    [System.ComponentModel.DataObject]
    public class TblStateTax : DatabaseUtility
    {
        #region TblStateTax Private Fields


        Int32 _stateTaxId;
        String _stateName = String.Empty;
        String _stateCode = String.Empty;
        Decimal _tax;
        Boolean _isActive;
        Boolean _isDeleted;
        DateTime _createDate;

        #endregion
        #region TblStateTax Constractor
        /// <summary>
        /// Creates an empty object of TblStateTax. 
        /// This is mainly used to create a new instance of TblStateTax to add a new TblStateTax.
        /// </summary>
        public TblStateTax() { }


        /// <summary>
        /// Used to retrieve employee information from database, 
        /// which is also used by Update method to save information of an existing TblStateTax.
        /// </summary>
        public TblStateTax
        (
            Int32 stateTaxId,
            String stateName,
            String stateCode,
            Decimal tax,
            Boolean isActive,
            Boolean isDeleted,
            DateTime createDate
        )
        {
            _stateTaxId = stateTaxId;
            _stateName = stateName;
            _stateCode = stateCode;
            _tax = tax;
            _isActive = isActive;
            _isDeleted = isDeleted;
            _createDate = createDate;
        }

        #endregion
        #region TblStateTax Properties

        /***********************************************************************************************
                                    -- PROPERTIES --        
         Contains all the properties representing the data fields of the current entity.
         ***********************************************************************************************/

        /// <summary>
        /// This is the Primary key value of the StateTaxId, which can't be assigned from the application,
        /// to ensure the data consistancy, by not letting the user to change the PK_TblStateTax to update the data of an another TblStateTax instance.
        /// For view or updation purpose, every TblStateTax will be retrieved thru the proper 'Get' method.
        /// </summary>

        public Int32 StateTaxId
        {
            get { return _stateTaxId; }
        }


        public String StateName
        {
            get { return _stateName; }
            set { _stateName = value; }
        }

        public String StateCode
        {
            get { return _stateCode; }
            set { _stateCode = value; }
        }

        public Decimal Tax
        {
            get { return _tax; }
            set { _tax = value; }
        }

        public Boolean IsActive
        {
            get { return _isActive; }
            set { _isActive = value; }
        }

        public Boolean IsDeleted
        {
            get { return _isDeleted; }
            set { _isDeleted = value; }
        }

        public DateTime CreateDate
        {
            get { return _createDate; }
            set { _createDate = value; }
        }


        #endregion
        #region TblStateTax Static Methods
        /************************************************************************************
                                    -- CREATE METHOD (STATIC) --
        *************************************************************************************/
        /************************* Architecure note:**********************************
        Note 1:
        This method is specially useful for the case, where we need to use Object Data Source controls.
        For ObjectDataSource/SqlDataSource controls, the insert/update metnod requires paramters methods, rather property based methods.
        However, there is still a way to pass property based objects as method parameter for data source controls, 
        but in that case we could not use Sql type, as view controls or asp parameter control can only contain few of primitive type.
        The main reason to remain the Sql Type in our object architecture is it is faster and contains better way for null value support.
        
        Note 2: 
        Non-primary key: it should be primitive type, as the asp paramter control (included in data source control) supports only primitive types.
        /*****************************************************************************/
        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Insert, true)]
        public static Int32 CreateNewTblStateTax
        (
            String stateName,
            String stateCode,
            Decimal tax,
            Boolean isActive,
            Boolean isDeleted,
            DateTime createDate
        )
        {
            //creating an empty TblStateTax object
            TblStateTax tblStateTax = new TblStateTax();
            tblStateTax.StateName = stateName;
            tblStateTax.StateCode = stateCode;
            tblStateTax.Tax = tax;
            tblStateTax.IsActive = isActive;
            tblStateTax.IsDeleted = isDeleted;
            tblStateTax.CreateDate = createDate;

            return TblStateTax.CreateNewTblStateTax(tblStateTax);
        }

        /************************************************************************************
                 -- UPDATE METHODS (STATIC) --
        *************************************************************************************/

        /************************* Architecure note:**********************************
        Note 1:
        This method is specially useful for the case, where we need to use Object Data Source controls.
        For ObjectDataSource/SqlDataSource controls, the insert/update metnod requires paramters methods, rather property based methods.
        However, there is still a way to pass property based objects as method parameter for data source controls, 
        but in that case we could not use Sql type, as view controls or asp parameter control can only contain few of primitive type.
        The main reason to remain the Sql Type in our object architecture is it is faster and contains better way for null value support.
        
        Note 2: 
        There the two types of paramaters will be passed here.
         * a. Primary key paramater: it should be Sql type, as we will bind the primary key property for the view controls (form view, details view etc) as datakey.
         * b. Non-primary key: it should be primitive type, as the asp paramter control (included in data source control) supports only primitive types.
        /*****************************************************************************/

        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Update, true)]
        public static bool UpdateTblStateTax
        (
            Int32 stateTaxId,
            String stateName,
            String stateCode,
            Decimal tax,
            Boolean isActive,
            Boolean isDeleted,
            DateTime createDate
        )
        {
            TblStateTax tblStateTax = TblStateTax.GetTblStateTaxByStateTaxId(stateTaxId);

            tblStateTax.StateName = stateName;
            tblStateTax.StateCode = stateCode;
            tblStateTax.Tax = tax;
            tblStateTax.IsActive = isActive;
            tblStateTax.IsDeleted = isDeleted;
            tblStateTax.CreateDate = createDate;

            return TblStateTax.UpdateTblStateTax(tblStateTax);
        }

        /************************************************************************************
                         -- DELETE METHODS --
        *************************************************************************************/
        /************************* Architecure note:**********************************
        We have used the employeeId parameter as SqlInt32, to bind the delete method with object data source and view control directly.
        ****************************************************************************/
        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Update, true)]
        public static bool DeleteTblStateTax
        (
            Int32 stateTaxId
        )
        {
            //Validate Input
            if (stateTaxId <= GetStateTaxIdMinValue)
                throw (new ArgumentOutOfRangeException("stateTaxId"));

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);
            AddParameterToSqlCmd(sqlCmd, "@StateTaxId", SqlDbType.Int, 0, ParameterDirection.Input, stateTaxId);
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLSTATETAX_DELETETBLSTATETAX);
            ExecuteScalarCmd(sqlCmd);
            int returnValue = (int)sqlCmd.Parameters["@ReturnValue"].Value;
            return (returnValue == 0 ? false : true);

        }

        /// <summary>
        /// Deletes a set of employees from the database.
        /// </summary>
        public static bool DeleteTblStateTaxList(System.Collections.Generic.List<Int32> stateTaxIdListToDelete)
        {
            //Validate Input
            foreach (Int32 stateTaxId in stateTaxIdListToDelete)
                if (stateTaxId <= GetStateTaxIdMinValue)
                    throw (new ArgumentOutOfRangeException("stateTaxId"));

            //performing deletion operation //

            string xmlString = FormatXMLForIdArray(stateTaxIdListToDelete);

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);
            AddParameterToSqlCmd(sqlCmd, "@StateTaxIdList", SqlDbType.Xml, xmlString.ToString().Length, ParameterDirection.Input, xmlString.ToString());
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLSTATETAX_DELETETBLSTATETAXLIST);
            ExecuteScalarCmd(sqlCmd);
            int returnValue = (int)sqlCmd.Parameters["@ReturnValue"].Value;
            return (returnValue == stateTaxIdListToDelete.Count ? true : false);
        }

        /************************************************************************************
                                 -- GET BY PRIMARY METHODS --
        *************************************************************************************/
        /************************* Architecure note:**********************************
        Retrives an Employee from database, based on it's primary key.
        To view or update an employee, everytime we must have to use this type of 'get' method, 
        since we don't have direct access to the Primary key value for assigning value.
        We have used the employeeId parameter as SqlInt32, to bind the delete method with object data source and view control directly.
        /*****************************************************************************/
        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Select, true)]
        public static TblStateTax GetTblStateTaxByStateTaxId(Int32 stateTaxId)
        {
            if (stateTaxId <= GetStateTaxIdMinValue)
                throw (new ArgumentOutOfRangeException("stateTaxId"));

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            AddParameterToSqlCmd(sqlCmd, "@StateTaxId", SqlDbType.Int, 0, ParameterDirection.Input, stateTaxId);
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLSTATETAX_GETTBLSTATETAXBYSTATETAXID);
            GenerateCollectionFromReader test = new GenerateCollectionFromReader(GenerateTblStateTaxCollectionFromReader);
            CustomCollection<TblStateTax> objCollection = ((CustomCollection<TblStateTax>)ExecuteReaderCmd(sqlCmd, test));

            if (objCollection.Count > 0)
                return objCollection[0];
            else
                return null;
        }

        /************************************************************************************
                         -- GET BY FOREIGN KEY METHODS --
        *************************************************************************************/

        /************************************************************************************
                 -- GET ALL METHODS --
        *************************************************************************************/
        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Select, true)]
        public static CustomCollection<TblStateTax> GetAllTblStateTax()
        {

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLSTATETAX_GETALLTBLSTATETAX);
            GenerateCollectionFromReader test = new GenerateCollectionFromReader(GenerateTblStateTaxCollectionFromReader);
            CustomCollection<TblStateTax> objCollection = ((CustomCollection<TblStateTax>)ExecuteReaderCmd(sqlCmd, test));

            return objCollection;
        }

        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Select, true)]
        public static CustomCollection<TblStateTax> GetAllTblStateTaxPaged(String orderBy, Int32 startRowIndex, Int32 maximumRows)
        {
            //Validate Input
            if (orderBy == "")
                orderBy = "StateTaxId";

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            AddParameterToSqlCmd(sqlCmd, "@orderby", SqlDbType.VarChar, 50, ParameterDirection.Input, orderBy);
            AddParameterToSqlCmd(sqlCmd, "@startrow", SqlDbType.Int, 0, ParameterDirection.Input, startRowIndex);
            AddParameterToSqlCmd(sqlCmd, "@pagesize", SqlDbType.Int, 0, ParameterDirection.Input, maximumRows);

            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLSTATETAX_GETALLTBLSTATETAXPAGED);

            GenerateCollectionFromReader test = new GenerateCollectionFromReader(GenerateTblStateTaxCollectionFromReader);
            CustomCollection<TblStateTax> objCollection = ((CustomCollection<TblStateTax>)ExecuteReaderCmd(sqlCmd, test));
            return objCollection;
        }

        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Select, true)]
        public static int GetAllTblStateTaxPagedCount(String orderBy, Int32 startRowIndex, Int32 maximumRows)
        {
            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();

            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLSTATETAX_GETALLTBLSTATETAXPAGEDCOUNT);
            ExecuteScalarCmd(sqlCmd);

            int returnValue = (int)sqlCmd.Parameters["@ReturnValue"].Value;
            return returnValue;
        }

        #endregion
        #region Employee Instance Methods
        /************************************************************************************
                                    -- SAVE (INSERT/UPDATE) METHODS (INSTANCE) --
        *************************************************************************************/
        /// <summary>
        /// Saves (inserts and updates) an Employee into database.
        /// The insertion occur if the EmployeeId conatins default value.
        /// Otherwises it updates the Employee into the database, based on the primary key value stored in EmployeeId.
        /// This technique ensures an Employee will not be updated without having a valid EmployeeId.
        /// </summary>
        public bool Save()
        {
            if (StateTaxId <= GetStateTaxIdMinValue)
            {
                Int32 TempId = CreateNewTblStateTax(this);
                if (TempId > 0)
                {
                    _stateTaxId = TempId;
                    return true;
                }
                else
                {
                    // error occurs
                    return false;
                }
            }
            else
            {	//This is a update Command
                return (UpdateTblStateTax(this));
            }

        }

        public static Int32 CreateNewTblStateTax(TblStateTax newTblStateTax)
        {
            // validate Parameters
            if (newTblStateTax == null)
                throw (new ArgumentNullException("newTblStateTax"));

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            int length = 0;
            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);

            AddParameterToSqlCmd(sqlCmd, "@StateName", SqlDbType.NVarChar, 500, ParameterDirection.Input, newTblStateTax.StateName);
            AddParameterToSqlCmd(sqlCmd, "@StateCode", SqlDbType.NVarChar, 50, ParameterDirection.Input, newTblStateTax.StateCode);
            AddParameterToSqlCmd(sqlCmd, "@Tax", SqlDbType.Decimal, 9, ParameterDirection.Input, newTblStateTax.Tax);
            AddParameterToSqlCmd(sqlCmd, "@IsActive", SqlDbType.Bit, 0, ParameterDirection.Input, newTblStateTax.IsActive);
            AddParameterToSqlCmd(sqlCmd, "@IsDeleted", SqlDbType.Bit, 0, ParameterDirection.Input, newTblStateTax.IsDeleted);
            AddParameterToSqlCmd(sqlCmd, "@CreateDate", SqlDbType.DateTime, 0, ParameterDirection.Input, newTblStateTax.CreateDate);

            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLSTATETAX_CREATENEWTBLSTATETAX);
            ExecuteScalarCmd(sqlCmd);
            return (Int32.Parse(sqlCmd.Parameters["@ReturnValue"].Value.ToString()));

        }
        /// <summary>
        /// Updates an TblStateTax instance to the database.
        /// </summary>
        public static bool UpdateTblStateTax(TblStateTax newTblStateTax)
        {
            // validate Parameters
            if (newTblStateTax == null)
                throw (new ArgumentNullException("newTblStateTax"));

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            int length = 0;
            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);

            AddParameterToSqlCmd(sqlCmd, "@StateTaxId", SqlDbType.Int, 0, ParameterDirection.Input, newTblStateTax.StateTaxId);
            AddParameterToSqlCmd(sqlCmd, "@StateName", SqlDbType.NVarChar, 500, ParameterDirection.Input, newTblStateTax.StateName);
            AddParameterToSqlCmd(sqlCmd, "@StateCode", SqlDbType.NVarChar, 50, ParameterDirection.Input, newTblStateTax.StateCode);
            AddParameterToSqlCmd(sqlCmd, "@Tax", SqlDbType.Decimal, 9, ParameterDirection.Input, newTblStateTax.Tax);
            AddParameterToSqlCmd(sqlCmd, "@IsActive", SqlDbType.Bit, 0, ParameterDirection.Input, newTblStateTax.IsActive);
            AddParameterToSqlCmd(sqlCmd, "@IsDeleted", SqlDbType.Bit, 0, ParameterDirection.Input, newTblStateTax.IsDeleted);
            AddParameterToSqlCmd(sqlCmd, "@CreateDate", SqlDbType.DateTime, 0, ParameterDirection.Input, newTblStateTax.CreateDate);

            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLSTATETAX_UPDATETBLSTATETAX);
            ExecuteScalarCmd(sqlCmd);
            int returnValue = (int)sqlCmd.Parameters["@ReturnValue"].Value;
            return (returnValue == 0 ? false : true);
        }
        #endregion

        #region TblStateTax Related Collections
        /// <summary>
        /// Creates and returns a strongly typed collection of Employee custom entity. 
        /// The colelction is created through iterating on the IdataReader object which contains Employee information, as a set of records, similar to tabular format.
        /// </summary>
        public static CollectionBase GenerateTblStateTaxCollectionFromReader(IDataReader returnData)
        {

            //creating the instance of Employee collection
            CustomCollection<TblStateTax> colTblStateTax = new CustomCollection<TblStateTax>();

            /************************* Architecure note:**********************************
             * Below code includes the null value functionality to retieve the data which has nill value in database end.
             * Design consideration:
             * Besides general data fields, special care should be taken for primary keys, to assign '0'/defaultvalue, rather passing 'Null' value in constructor parameter.
             * Although we are considering sqldb tyoe data for the current data container, but while retireving data from database end, through datareader object, we need to cast data reader objects using .net primitive data type, 
             * rather using sqldb type to cast, since data reader objects don't support sql db type to be casted.
             *****************************************************************************/

            //Iterating thriugh the data reader, to generate Employee collection.

            //getting the Employee collection by iterating thru the data reader
            while (returnData.Read())
            {
                //passing the TblStateTax constructor parameters from the current instance of data reader fields.
                TblStateTax newTblStateTax = new TblStateTax
                (
                    returnData["StateTaxId"] == System.DBNull.Value ? GetStateTaxIdMinValue : (Int32)returnData["StateTaxId"],
                    returnData["StateName"] == System.DBNull.Value ? string.Empty : (String)returnData["StateName"],
                    returnData["StateCode"] == System.DBNull.Value ? string.Empty : (String)returnData["StateCode"],
                    returnData["Tax"] == System.DBNull.Value ? 0 : (Decimal)returnData["Tax"],
                    returnData["IsActive"] == System.DBNull.Value ? false : (Boolean)returnData["IsActive"],
                    returnData["IsDeleted"] == System.DBNull.Value ? false : (Boolean)returnData["IsDeleted"],
                    returnData["CreateDate"] == System.DBNull.Value ? DateTime.MinValue : (DateTime)returnData["CreateDate"]

                );
                //adding the Employee to the collection
                colTblStateTax.Add(newTblStateTax);
            }

            //returns the collection of Companys 
            return (colTblStateTax);
        }

        #endregion
        #region Constants and Default Values

        public static Int32 GetStateTaxIdMinValue
        {
            get
            {
                return 0;
            }
        }

        //create method related contants
        internal const string SP_TBLSTATETAX_CREATENEWTBLSTATETAX = "sp_TblStateTax_CreateNewTblStateTax";
        internal const string SP_TBLSTATETAX_UPDATETBLSTATETAX = "sp_TblStateTax_UpdateTblStateTax";
        internal const string SP_TBLSTATETAX_DELETETBLSTATETAX = "sp_TblStateTax_DeleteTblStateTax";
        internal const string SP_TBLSTATETAX_DELETETBLSTATETAXLIST = "sp_TblStateTax_DeleteTblStateTaxList";
        internal const string SP_TBLSTATETAX_GETTBLSTATETAXBYSTATETAXID = "sp_TblStateTax_GetTblStateTaxByStateTaxId";
        internal const string SP_TBLSTATETAX_GETALLTBLSTATETAX = "sp_TblStateTax_GetAllTblStateTax";
        internal const string SP_TBLSTATETAX_GETALLTBLSTATETAXPAGED = "sp_TblStateTax_GetAllTblStateTaxPaged";
        internal const string SP_TBLSTATETAX_GETALLTBLSTATETAXPAGEDCOUNT = "sp_TblStateTax_GetAllTblStateTaxPagedCount";

        #endregion
    }
}
